RangeParameter Class Reference
[VST Implementation Helper Classes]

Description of a RangeParameter. More...

#include <vstparameters.h>

Inheritance diagram for RangeParameter:
Inheritance graph
[legend]

Public Member Functions

 RangeParameter (const ParameterInfo &paramInfo, ParamValue min, ParamValue max)
 RangeParameter (const TChar *title, ParamID tag, const TChar *units=0, ParamValue minPlain=0., ParamValue maxPlain=1., ParamValue defaultValuePlain=0., int32 stepCount=0, int32 flags=ParameterInfo::kCanAutomate, UnitID unitID=kRootUnitId)
virtual ParamValue getMin () const
 Gets the minimum plain value, same as toPlain (0).
virtual void setMin (ParamValue value)
 Sets the minimum plain value.
virtual ParamValue getMax () const
 Gets the maximum plain value, same as toPlain (1).
virtual void setMax (ParamValue value)
 Sets the maximum plain value.
virtual void toString (ParamValue valueNormalized, String128 string) const
 Converts a normalized value to a string.
virtual bool fromString (const TChar *string, ParamValue &valueNormalized) const
 Converts a string to a normalized value.
virtual ParamValue toPlain (ParamValue valueNormalized) const
 Converts a normalized value to plain value (e.g.
virtual ParamValue toNormalized (ParamValue plainValue) const
 Converts a plain value to a normalized value (e.g.

Data Fields

OBJ_METHODS(RangeParameter,
Parameter) protected
ParamValue 
minPlain
ParamValue maxPlain

Detailed Description

Description of a RangeParameter.


Constructor & Destructor Documentation

RangeParameter ( const ParameterInfo paramInfo,
ParamValue  min,
ParamValue  max 
)
RangeParameter ( const TChar title,
ParamID  tag,
const TChar units = 0,
ParamValue  minPlain = 0.,
ParamValue  maxPlain = 1.,
ParamValue  defaultValuePlain = 0.,
int32  stepCount = 0,
int32  flags = ParameterInfo::kCanAutomate,
UnitID  unitID = kRootUnitId 
)

Member Function Documentation

virtual ParamValue getMin (  )  const [inline, virtual]

Gets the minimum plain value, same as toPlain (0).

virtual void setMin ( ParamValue  value  )  [inline, virtual]

Sets the minimum plain value.

virtual ParamValue getMax (  )  const [inline, virtual]

Gets the maximum plain value, same as toPlain (1).

virtual void setMax ( ParamValue  value  )  [inline, virtual]

Sets the maximum plain value.

void toString ( ParamValue  valueNormalized,
String128  string 
) const [virtual]

Converts a normalized value to a string.

Reimplemented from Parameter.

bool fromString ( const TChar string,
ParamValue valueNormalized 
) const [virtual]

Converts a string to a normalized value.

Reimplemented from Parameter.

ParamValue toPlain ( ParamValue  valueNormalized  )  const [virtual]

Converts a normalized value to plain value (e.g.

0.5 to 10000.0Hz).

Reimplemented from Parameter.

ParamValue toNormalized ( ParamValue  plainValue  )  const [virtual]

Converts a plain value to a normalized value (e.g.

10000 to 0.5).

Reimplemented from Parameter.


Field Documentation

OBJ_METHODS (RangeParameter, Parameter) protected ParamValue minPlain
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.